Wraps a nkExport::Node and offers functions for use in scripting.
More...
Wraps a nkExport::Node and offers functions for use in scripting.
◆ updateEnvironment()
Updates a given environment and set it up to use all functions wrapped by this wrapper.
- Parameters
-
env | The environment to set up. |
◆ constructor()
static void* nkAstraeus::lua::nkExportWrap::NodeWrapper::constructor |
( |
const nkScripts::DataStack & |
stack | ) |
|
|
static |
Wrapper function for the constructor of the user type.
local t = nkExport.Node.new() ;
- Parameters
-
stack | The parameter stack. |
- Returns
- An output value with the user type and data allocated.
◆ destructor()
static void nkAstraeus::lua::nkExportWrap::NodeWrapper::destructor |
( |
void * |
toDestroy | ) |
|
|
static |
Wrapper function for the destructor of the user type.
- Parameters
-
toDestroy | The data that has to be freed. |
◆ getString()
Wrapper function for the nkExport::Node::getValueAsString() attribute reading.
local d = node.valueString ;
- Parameters
-
node | The data from which the attribute will be retrieved. |
- Returns
- The attribute value, as a string.
◆ getInt()
Wrapper function for the nkExport::Node::getValueAsInt() attribute reading.
local d = node.valueInt ;
- Parameters
-
node | The data from which the attribute will be retrieved. |
- Returns
- The attribute value, as an int.
◆ getFloat()
Wrapper function for the nkExport::Node::getValueAsFloat() attribute reading.
local d = node.valueFloat ;
- Parameters
-
node | The data from which the attribute will be retrieved. |
- Returns
- The attribute value, as an float.
◆ getDouble()
Wrapper function for the nkExport::Node::getValueAsDouble() attribute reading.
local d = node.valueDouble ;
- Parameters
-
node | The data from which the attribute will be retrieved. |
- Returns
- The attribute value, as a double.
◆ getBool()
Wrapper function for the nkExport::Node::getValueAsBool() attribute reading.
local d = node.valueBool ;
- Parameters
-
node | The data from which the attribute will be retrieved. |
- Returns
- The attribute value, as a bool.
◆ getNodeNature()
◆ getNodeValueType()
◆ getArraySize()
Wrapper function for the nkExport::Node::getValueAsString() attribute reading.
local d = node.valueString ;
- Parameters
-
node | The data from which the attribute will be retrieved. |
- Returns
- The attribute value, as a string.
◆ isValueTypeNumber()
◆ getArrayElement()
Wrapper function for nkExport::getArrayElement().
local d = node:getArrayElement(0) ;
- Parameters
-
stack | The parameter stack. |
- Returns
- The output value, as a nkExport::Node.
◆ getMemberValue()
◆ setString()
static void nkAstraeus::lua::nkExportWrap::NodeWrapper::setString |
( |
const nkScripts::DataStack & |
stack | ) |
|
|
static |
Wrapper function for nkExport::Node::setAsString(), exposed as an attribute setter.
node.valueString = "str" ;
- Parameters
-
stack | The parameter stack. |
- Returns
- The output value, empty.
◆ setInt()
static void nkAstraeus::lua::nkExportWrap::NodeWrapper::setInt |
( |
const nkScripts::DataStack & |
stack | ) |
|
|
static |
Wrapper function for nkExport::Node::setAsInt(), exposed as an attribute setter.
node.valueInt = 2 ;
- Parameters
-
stack | The parameter stack. |
- Returns
- The output value, empty.
◆ setFloat()
static void nkAstraeus::lua::nkExportWrap::NodeWrapper::setFloat |
( |
const nkScripts::DataStack & |
stack | ) |
|
|
static |
Wrapper function for nkExport::Node::setAsFloat(), exposed as an attribute setter.
node.valueFloat = 0.5 ;
- Parameters
-
stack | The parameter stack. |
- Returns
- The output value, empty.
◆ setDouble()
static void nkAstraeus::lua::nkExportWrap::NodeWrapper::setDouble |
( |
const nkScripts::DataStack & |
stack | ) |
|
|
static |
Wrapper function for nkExport::Node::setAsDouble(), exposed as an attribute setter.
node.valueDouble = 0.5 ;
- Parameters
-
stack | The parameter stack. |
- Returns
- The output value, empty.
◆ setBool()
static void nkAstraeus::lua::nkExportWrap::NodeWrapper::setBool |
( |
const nkScripts::DataStack & |
stack | ) |
|
|
static |
Wrapper function for nkExport::Node::setAsBool(), exposed as an attribute setter.
node.valueBool = false ;
- Parameters
-
stack | The parameter stack. |
- Returns
- The output value, empty.
◆ addElement()
◆ addMember()
The documentation for this class was generated from the following file:
- Documentation/Headers/NilkinsAstraeus/Scripts/Lua/nkExportWrap/Tree/NodeWrapper.h